<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>LibCDS: /home/zsshen/Desktop/git-hub-code/C-Common-Data-Structures/include/tree/simple_tree.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">LibCDS
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('simple__tree_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">simple_tree.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="simple__tree_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * @file simple_tree.h The basic binary search tree.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#ifndef _SIMPLE_TREE_H_</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _SIMPLE_TREE_H_</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &quot;../util.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">/** SimTreeData is the data type for the container private information. */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="simple__tree_8h.html#ade561e68da2347c9616c57a54790f581">   11</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_SimTreeData <a class="code" href="simple__tree_8h.html#ade561e68da2347c9616c57a54790f581">SimTreeData</a>;</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">/** The implementation for basic binary search tree. */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structSimpleTree.html">   14</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_SimpleTree {<span class="comment"></span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">    /** The container private information. */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structSimpleTree.html#ab428fd1423b915b7a4d25955b73bcb78">   16</a></span>&#160;    <a class="code" href="simple__tree_8h.html#ade561e68da2347c9616c57a54790f581">SimTreeData</a> *<a class="code" href="structSimpleTree.html#ab428fd1423b915b7a4d25955b73bcb78">pData</a>;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">    /** Insert an item into the tree.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">        @see SimTreeInsert */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structSimpleTree.html#a069c5cca27e6bb50c406693584ef3008">   20</a></span>&#160;    int32_t (*insert) (<span class="keyword">struct </span>_SimpleTree*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>, bool);</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">    /** Search for the item having the same order with the designated one.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">        @see SimTreeSearch */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structSimpleTree.html#a749f837f617b361f9d23c40bd6f259f0">   24</a></span>&#160;    int32_t (*search) (<span class="keyword">struct </span>_SimpleTree*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>*);</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">    /** Delete the item having the same order with the designated one.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">        @see SimTreeDelete */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structSimpleTree.html#acc3e5e9958f136af5dba590a37f1744a">   28</a></span>&#160;    int32_t (*<span class="keyword">delete</span>) (<span class="keyword">struct </span>_SimpleTree*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>, bool);</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">    /** Get the item having the maximum order of the tree.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">        @see SimTreeMaximum */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structSimpleTree.html#a955b93a5a5b1e6a1c125950d4c629cf4">   32</a></span>&#160;    int32_t (*maximum) (<span class="keyword">struct </span>_SimpleTree*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>*);</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">    /** Get the item having the minimum order of the tree.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">        @see SimTreeMinimum */</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structSimpleTree.html#a0e9da8950727c048d5d96c2f25cd9c9d">   36</a></span>&#160;    int32_t (*minimum) (<span class="keyword">struct </span>_SimpleTree*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>*);</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">    /** Get the immediate successor of the designated item.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">        @see SimTreeSuccessor */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structSimpleTree.html#a13fffae9159e386abf479c9ffd03b0af">   40</a></span>&#160;    int32_t (*successor) (<span class="keyword">struct </span>_SimpleTree*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>*);</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">    /** Get the immediate predecessor of the designated item.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">        @see SimTreePredecessor */</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structSimpleTree.html#a90335ce9d49ed0619f0478606de471b4">   44</a></span>&#160;    int32_t (*predecessor) (<span class="keyword">struct </span>_SimpleTree*, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>*);</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">    /** Get the number of stored item.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">        @see SimTreeSize */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structSimpleTree.html#a3875f93f1d4c26126655aae39a08913b">   48</a></span>&#160;    int32_t (*size) (<span class="keyword">struct </span>_SimpleTree*);</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">    /** Set the user defined item comparison method.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">        @see SimTreeSetCompare */</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structSimpleTree.html#ad5acf97627904420f5bb18ec1b327216">   52</a></span>&#160;    int32_t (*set_compare) (<span class="keyword">struct </span>_SimpleTree*, int32_t (*) (<a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>));</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">    /** Set the user defined item clean method.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">        @see SimTreeSetDestroy */</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structSimpleTree.html#a8853a892b55c1486b55236dca59d696a">   56</a></span>&#160;    int32_t (*set_destroy) (<span class="keyword">struct </span>_SimpleTree*, void (*) (<a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>));</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;} <a class="code" href="structSimpleTree.html">SimpleTree</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"> * @brief The constructor for SimpleTree.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be constructed tree</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for tree construction</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;int32_t <a class="code" href="simple__tree_8h.html#a464772056a4bc22cb84951c7cd5f06a2">SimTreeInit</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> **ppObj);</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment"> * @brief The destructor for SimpleTree.</span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment"> * If the knob is on, it also runs the resource clean method for all the items.</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be destructed tree</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="keywordtype">void</span> <a class="code" href="simple__tree_8h.html#ab238b9ff82c7352637ff62a37afa73cf">SimTreeDeinit</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> **ppObj, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"> * @brief Insert an item into the tree.</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment"> * This function inserts an item into the tree. If the order of the designated</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment"> * item is the same with a certain one stored in the tree, that item will be</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment"> * replaced. Also, if the knob is on, it runs the resource clean method for the</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> * replaced item.</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"> * @param self          The pointer to the SimpleTree structure</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for tree extension</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;int32_t <a class="code" href="simple__tree_8h.html#a5403041ee9dd256c451889a5d53c75ce">SimTreeInsert</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> item, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> * @brief Search for the item having the same order with the designated one.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"> * This function searches for an item having the same order with the designated</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment"> * one. If such item can be found, it will be returned by the third parameter.</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"> * Otherwise, the error code is returned and the third parameter is updated with</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment"> * NULL.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"> * @param self          The pointer to the SimpleTree structure</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment"> * @param itemIn        The designated item</span></div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment"> * @param pItemOut      The pointer to the returned item</span></div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment"> * @retval ERR_NODATA   Non-existent item</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;int32_t <a class="code" href="simple__tree_8h.html#a5a26a654e5f784ff1fec73625a027ab0">SimTreeSearch</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> itemIn, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> *pItemOut);</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"> * @brief Delete the item having the same order with the designated one.</span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment"> * This function first searches for the item having the same order with the</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment"> * designated one. If such item can be found, it will be removed. Also, if the</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment"> * knob is on, the function runs the resource clean method for the removed item.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment"> * @param self          The pointer to the SimpleTree structure</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment"> * @retval ERR_NODATA   Non-existent item</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;int32_t <a class="code" href="simple__tree_8h.html#afb81a382daf802759f9826c661ef7c74">SimTreeDelete</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> item, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment"> * @brief Return the item having the maximum order of the tree.</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"> * @param self          The pointer to the SimpleTree structure</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment"> * @param pItem         The pointer to the returned item</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty tree</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;int32_t <a class="code" href="simple__tree_8h.html#a2e6a210c04cefec27d948949e72515d2">SimTreeMaximum</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> *pItem);</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"> * @brief Return the item having the minimum order of the tree.</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"> * @param self          The pointer to the SimpleTree structure</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment"> * @param pItem         The pointer to the returned item</span></div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty tree</span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;int32_t <a class="code" href="simple__tree_8h.html#a12d9eb446ee0901adc45db968d62ad2f">SimTreeMinimum</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> *pItem);</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment"> * @brief Return the item which is the immediate successor of the designated item.</span></div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment"> * @param self          The pointer to the SimpleTree structure</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment"> * @param itemIn        The designated item</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment"> * @param pItemOut      The pointer to the returned item</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment"> * @retval ERR_NODATA   Non-existent immediate successor</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;int32_t <a class="code" href="simple__tree_8h.html#a6e62206c0c68c0c4aa575da6e83c17df">SimTreeSuccessor</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> itemIn, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> *pItemOut);</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment"> * @brief Return the item which is the immediate predecessor of the designated item.</span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment"> * @param self          The pointer to the SimpleTree structure</span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment"> * @param itemIn        The designated item</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="comment"> * @param pItemOut      The pointer to the returned item</span></div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment"> * @retval ERR_NODATA   Non-existent immediate predecessor</span></div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;int32_t <a class="code" href="simple__tree_8h.html#a9e61e5f20ead969f2df3d697c46e68d1">SimTreePredecessor</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> itemIn, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a> *pItemOut);</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment"> * @brief Return the number of stored items.</span></div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;<span class="comment"> * @param self          The pointer to the SimpleTree structure.</span></div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="comment"> * @return              The number of stored items</span></div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;int32_t <a class="code" href="simple__tree_8h.html#abf9cdf9706dd9fd15c0d732beb548e43">SimTreeSize</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> *<span class="keyword">self</span>);</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment"> * @brief Set the user defined item comparison method.</span></div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment"> * @param self          The pointer to the SimpleTree structure</span></div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="comment"> * @param pFunc         The function pointer to the custom method</span></div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;int32_t <a class="code" href="simple__tree_8h.html#a1ed803a976373ede2d70564eadcfc2e5">SimTreeSetCompare</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> *<span class="keyword">self</span>, int32_t (*pFunc) (<a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>, <a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>));</div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;<span class="comment"> * @brief Set the user defined item clean method.</span></div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;<span class="comment"> * @param self          The pointer to the SimpleTree structure</span></div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;<span class="comment"> * @param pFunc         The function pointer to the custom method</span></div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;int32_t <a class="code" href="simple__tree_8h.html#abaa00660ddf70bcaa3e8abb13a4f5579">SimTreeSetDestroy</a>(<a class="code" href="structSimpleTree.html">SimpleTree</a> *<span class="keyword">self</span>, <span class="keywordtype">void</span> (*pFunc) (<a class="code" href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a>));</div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;</div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="simple__tree_8h_html_a2e6a210c04cefec27d948949e72515d2"><div class="ttname"><a href="simple__tree_8h.html#a2e6a210c04cefec27d948949e72515d2">SimTreeMaximum</a></div><div class="ttdeci">int32_t SimTreeMaximum(SimpleTree *self, Item *pItem)</div><div class="ttdoc">Return the item having the maximum order of the tree. </div></div>
<div class="ttc" id="simple__tree_8h_html_afb81a382daf802759f9826c661ef7c74"><div class="ttname"><a href="simple__tree_8h.html#afb81a382daf802759f9826c661ef7c74">SimTreeDelete</a></div><div class="ttdeci">int32_t SimTreeDelete(SimpleTree *self, Item item, bool bClean)</div><div class="ttdoc">Delete the item having the same order with the designated one. </div></div>
<div class="ttc" id="simple__tree_8h_html_a9e61e5f20ead969f2df3d697c46e68d1"><div class="ttname"><a href="simple__tree_8h.html#a9e61e5f20ead969f2df3d697c46e68d1">SimTreePredecessor</a></div><div class="ttdeci">int32_t SimTreePredecessor(SimpleTree *self, Item itemIn, Item *pItemOut)</div><div class="ttdoc">Return the item which is the immediate predecessor of the designated item. </div></div>
<div class="ttc" id="simple__tree_8h_html_a464772056a4bc22cb84951c7cd5f06a2"><div class="ttname"><a href="simple__tree_8h.html#a464772056a4bc22cb84951c7cd5f06a2">SimTreeInit</a></div><div class="ttdeci">int32_t SimTreeInit(SimpleTree **ppObj)</div><div class="ttdoc">The constructor for SimpleTree. </div></div>
<div class="ttc" id="util_8h_html_a2583da5c1c14184068bda8cf681d5bed"><div class="ttname"><a href="util_8h.html#a2583da5c1c14184068bda8cf681d5bed">Item</a></div><div class="ttdeci">const void * Item</div><div class="ttdoc">Item is the data type for the container element. </div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00030">util.h:30</a></div></div>
<div class="ttc" id="simple__tree_8h_html_ab238b9ff82c7352637ff62a37afa73cf"><div class="ttname"><a href="simple__tree_8h.html#ab238b9ff82c7352637ff62a37afa73cf">SimTreeDeinit</a></div><div class="ttdeci">void SimTreeDeinit(SimpleTree **ppObj, bool bClean)</div><div class="ttdoc">The destructor for SimpleTree. </div></div>
<div class="ttc" id="simple__tree_8h_html_a1ed803a976373ede2d70564eadcfc2e5"><div class="ttname"><a href="simple__tree_8h.html#a1ed803a976373ede2d70564eadcfc2e5">SimTreeSetCompare</a></div><div class="ttdeci">int32_t SimTreeSetCompare(SimpleTree *self, int32_t(*pFunc)(Item, Item))</div><div class="ttdoc">Set the user defined item comparison method. </div></div>
<div class="ttc" id="simple__tree_8h_html_abaa00660ddf70bcaa3e8abb13a4f5579"><div class="ttname"><a href="simple__tree_8h.html#abaa00660ddf70bcaa3e8abb13a4f5579">SimTreeSetDestroy</a></div><div class="ttdeci">int32_t SimTreeSetDestroy(SimpleTree *self, void(*pFunc)(Item))</div><div class="ttdoc">Set the user defined item clean method. </div></div>
<div class="ttc" id="simple__tree_8h_html_ade561e68da2347c9616c57a54790f581"><div class="ttname"><a href="simple__tree_8h.html#ade561e68da2347c9616c57a54790f581">SimTreeData</a></div><div class="ttdeci">struct _SimTreeData SimTreeData</div><div class="ttdoc">SimTreeData is the data type for the container private information. </div><div class="ttdef"><b>Definition:</b> <a href="simple__tree_8h_source.html#l00011">simple_tree.h:11</a></div></div>
<div class="ttc" id="simple__tree_8h_html_a6e62206c0c68c0c4aa575da6e83c17df"><div class="ttname"><a href="simple__tree_8h.html#a6e62206c0c68c0c4aa575da6e83c17df">SimTreeSuccessor</a></div><div class="ttdeci">int32_t SimTreeSuccessor(SimpleTree *self, Item itemIn, Item *pItemOut)</div><div class="ttdoc">Return the item which is the immediate successor of the designated item. </div></div>
<div class="ttc" id="structSimpleTree_html_ab428fd1423b915b7a4d25955b73bcb78"><div class="ttname"><a href="structSimpleTree.html#ab428fd1423b915b7a4d25955b73bcb78">SimpleTree::pData</a></div><div class="ttdeci">SimTreeData * pData</div><div class="ttdoc">The container private information. </div><div class="ttdef"><b>Definition:</b> <a href="simple__tree_8h_source.html#l00016">simple_tree.h:16</a></div></div>
<div class="ttc" id="simple__tree_8h_html_a12d9eb446ee0901adc45db968d62ad2f"><div class="ttname"><a href="simple__tree_8h.html#a12d9eb446ee0901adc45db968d62ad2f">SimTreeMinimum</a></div><div class="ttdeci">int32_t SimTreeMinimum(SimpleTree *self, Item *pItem)</div><div class="ttdoc">Return the item having the minimum order of the tree. </div></div>
<div class="ttc" id="simple__tree_8h_html_a5403041ee9dd256c451889a5d53c75ce"><div class="ttname"><a href="simple__tree_8h.html#a5403041ee9dd256c451889a5d53c75ce">SimTreeInsert</a></div><div class="ttdeci">int32_t SimTreeInsert(SimpleTree *self, Item item, bool bClean)</div><div class="ttdoc">Insert an item into the tree. </div></div>
<div class="ttc" id="structSimpleTree_html"><div class="ttname"><a href="structSimpleTree.html">SimpleTree</a></div><div class="ttdoc">The implementation for basic binary search tree. </div><div class="ttdef"><b>Definition:</b> <a href="simple__tree_8h_source.html#l00014">simple_tree.h:14</a></div></div>
<div class="ttc" id="simple__tree_8h_html_abf9cdf9706dd9fd15c0d732beb548e43"><div class="ttname"><a href="simple__tree_8h.html#abf9cdf9706dd9fd15c0d732beb548e43">SimTreeSize</a></div><div class="ttdeci">int32_t SimTreeSize(SimpleTree *self)</div><div class="ttdoc">Return the number of stored items. </div></div>
<div class="ttc" id="simple__tree_8h_html_a5a26a654e5f784ff1fec73625a027ab0"><div class="ttname"><a href="simple__tree_8h.html#a5a26a654e5f784ff1fec73625a027ab0">SimTreeSearch</a></div><div class="ttdeci">int32_t SimTreeSearch(SimpleTree *self, Item itemIn, Item *pItemOut)</div><div class="ttdoc">Search for the item having the same order with the designated one. </div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_90ea79f90f3277a1d53059d67fa84fee.html">tree</a></li><li class="navelem"><a class="el" href="simple__tree_8h.html">simple_tree.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
